Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / QuickFtp Class / GetFtpContents Method / GetFtpContents(String,Int32,String,String,String,Boolean,String[]) Method
The hostname of the FTP server to connect to. An IP address can also be used.
The port of the FTP server to which to connect to.
The username used to connect to the FTP server.
The password used to connect to the FTP server.
The path to the remote folder to list, for example, \ftproot\test.
Boolean value indicating if files contained within sub-folders should be listed from the FTP host.
The filters to apply for the GetFtpContents.


In This Topic
    GetFtpContents(String,Int32,String,String,String,Boolean,String[]) Method
    In This Topic
    Gets a listing of the provided remote folder, specifying a port, a username/password, filters, and whether the operation is recursive.
    Syntax
    'Declaration
     
    Public Overloads Shared Function GetFtpContents( _
       ByVal hostname As String, _
       ByVal port As Integer, _
       ByVal username As String, _
       ByVal password As String, _
       ByVal remoteFolderToList As String, _
       ByVal recursive As Boolean, _
       ByVal ParamArray filters() As String _
    ) As QuickFtpItem()
    'Usage
     
    Dim hostname As String
    Dim port As Integer
    Dim username As String
    Dim password As String
    Dim remoteFolderToList As String
    Dim recursive As Boolean
    Dim filters() As String
    Dim value() As QuickFtpItem
     
    value = QuickFtp.GetFtpContents(hostname, port, username, password, remoteFolderToList, recursive, filters)
    public static QuickFtpItem[] GetFtpContents( 
       string hostname,
       int port,
       string username,
       string password,
       string remoteFolderToList,
       bool recursive,
       params string[] filters
    )

    Parameters

    hostname
    The hostname of the FTP server to connect to. An IP address can also be used.
    port
    The port of the FTP server to which to connect to.
    username
    The username used to connect to the FTP server.
    password
    The password used to connect to the FTP server.
    remoteFolderToList
    The path to the remote folder to list, for example, \ftproot\test.
    recursive
    Boolean value indicating if files contained within sub-folders should be listed from the FTP host.
    filters
    The filters to apply for the GetFtpContents.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also